Inventti

NFSePack

Mais segurança e agilidade para o seu negócio. Versão 20.5.1

Integração via Web Service

O WEB Service possibilita a integração Cliente X NFSePack para a emissão de NFSe, onde é realizado a chamada do serviço passando como parâmetro uma string com o layout XML de entrada do NFSePack.

O layout do XML de entrada do NFSePack, atende todas as prefeituras contepladas pelo NFSePack. Conforme a solicitação de novos municípios, se necessário é inserido novos campos, entretando é mantido compatibilidade com integrações antigas. Sendo assim o cliente pode atualizar o NFSePack, sem precisar alterar a integração.

Após instalado no cliente, fica disponivel no seguinte endereço: http://localhost/NFSePackWebServices/WebServiceIntegracao.asmx

Serviços disponiveis: Schemas:

Tabela de valores:

Tipo Valor
dateTime 2013-03-01T11:26:14
2013-03-01T11:26:14.0595292-03:00
IndicadorCpfCnpj Cpf
Cnpj
CpfNaoInformado
Exterior
boolean false ou 0
true ou 1
Alíquotas 1% = 0.01
2,5% = 0.025
ResponsavelRetencao Tomador
Intermediário
Inicio

Recepcionar RPS

Este serviço é responsável por receber uma string com o layout XML padrão de entrada (NFSePack) com as informações referentes ao RPS a ser convertido em NFSe.

Layout XML:

TagTipoOcorrênciaTamanhoDecimaisDescrição
TNFSe1 - 100Representa a estrutura do XML de integração do RPS com o NFSePack
string0 - 12550Chave de acesso a integração via web service. Esta chave deve conferir com a chave gerada no cadastro do prestador. O objetivo é restringir que apenas pessoas com acesso a esta chave integrem RPS.
dateTime0 - 100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
integer0 - 180Ano Mês e Dia Competência
long0 - 1150Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string0 - 1300Código da Natureza de Operação
string0 - 1300Operação.
string0 - 1100Código do Serviço Prestado
integer0 - 110Optante pelo Simples Nacional
boolean0 - 100Incentivo a Cultura
string0 - 150Incentivo fiscal
long0 - 1150Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
long1 - 1150Número do RPS
string0 - 150Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string1 - 150Série do RPS
string0 - 1100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string1 - 1100Tipo de RPS
0 - 100
long1 - 1150Número do RPS
string1 - 150Série do RPS
string1 - 1100Tipo de RPS
string0 - 1200Número autorização
string0 - 1200Tipo autorização
dateTime1 - 100Data de Emissão do RPS
string0 - 110000Informações Adicionais ao Fisco
string0 - 1150Status/Situação do RPS
string0 - 1800Descrição/Motivo do cancelamento do RPS
string0 - 1200Código fiscal da prestação do serviço
long0 - 1150Número Guia
dateTime0 - 100Data e hora da quitação da guia
1 - 100Prestador dos Serviços
string1 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string1 - 11150Razão social
string0 - 1600Nome fantasia
long1 - 1140CPF/CNPJ
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 120DDD Telefone do Prestador
string0 - 1800Site
date0 - 100Data de Adesão do Simples Nacional
0 - 100Endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - 100Tomador dos Serviços
long0 - 1140CPF/CNPJ
string0 - 1300
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string0 - 1100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string0 - 11150Razão social
string0 - 1600Nome fantasia
string0 - 1300Situação
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 120DDD Telefone do Tomador
0 - 100Endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
string0 - 1600Número de identificação fiscal do tomador quando for do exterior
0 - 100Construção Civil
string1 - 1150Código da Obra
string1 - 1150Código da ART
string0 - 11500Nome da Obra
0 - 100Endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
decimal0 - 1152Dedução Material
decimal0 - 1152Dedução subempreitada
string0 - 1120Cadastro específico do INSS
0 - 100Atividade Portuária
string1 - 11500Nome/Razão Social do proprietário ou representante
long1 - 1140CPF/CNPJ
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
1 - 100Endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
boolean1 - 100É proprietário?
string1 - 11500Nome da Embarcação
string1 - 11500Bandeira da Embarcação
string1 - 11500Nome do porto
dateTime1 - 100Data de entrada
dateTime1 - 100Data de saída
0 - 100Intermediário
long1 - 1140CPF/CNPJ
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1150Inscrição municipal
string0 - 11150Razão social
integer0 - 170Código IBGE do município do Intermediário
string0 - 11250Descrição do endereço
string0 - 1100Número do endereço
string0 - 1600Bairro do endereço
0 - 100Cobrança
string0 - 1300Código
int0 - 140Número de parcelas
string0 - 12550Instrução de pagamento
string0 - 12550Forma de pagamento
0 - 100Fatura
int0 - 1150Número
decimal0 - 1152Valor original
decimal0 - 1152Valor de desconto
decimal0 - 1152Valor Líquido
dateTime0 - 100Data de vencimento
dateTime0 - 100Data de processamento
0 - 100Duplicata
1 - 100
int0 - 1150Número
dateTime0 - 100Data de vencimento
decimal0 - 1152
0 - 100
0 - 100
string0 - 11500Nome
string0 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
long0 - 1140CPF/CNPJ
0 - 100Endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
string0 - 11000Tipo do Frete
decimal0 - 1154Quantidade de Produto
string0 - 11000Espécie do Produto
decimal0 - 1154Peso Liquido
decimal0 - 1154Peso Bruto
0 - N00Informações Adicionais
string0 - 11500Nome
string1 - 12550Tag
string1 - 110000Valor
1 - N00Lista de discriminação dos Serviços
decimal1 - 1154Valor do Serviço
decimal0 - 1154Valor unitário
decimal0 - 1154Quantidade
string0 - 1200Unidade de medida
decimal0 - 1152Valor Deduções
string0 - 12550Descrição/motivo da dedução
decimal0 - 1152Valor PIS
decimal0 - 1156Alíquota PIS
decimal0 - 1152Valor COFINS
decimal0 - 1156Alíquota COFINS
decimal0 - 1152Valor INSS
decimal0 - 1156Alíquota INSS
decimal0 - 1152Valor IR
decimal0 - 1156Alíquota IR
decimal0 - 1152Valor CSLL
decimal0 - 1156Alíquota CSLL
string0 - 1100Código do serviço sem formatação Ex: "ISS-17.03" deve-se enviar "1703"
string0 - 1200CFOP
string0 - 12550Código CNAE
string0 - 1200ID do código CNAE
string0 - 1300Código de tributação municipal
decimal0 - 1154Valor da base de calcúlo ISS
decimal0 - 1156Alíquota ISS
decimal0 - 1152Valor ISS
decimal0 - 1152Valor Líquido
decimal0 - 1152Valor outras retenções
decimal0 - 1152Valor crédito
boolean0 - 100ISS é Retido?
decimal0 - 1152Valor do ISS Retido
decimal0 - 1152Valor do desconto incondicional
decimal0 - 1152Valor do desconto condicional
0 - 100Informações de ISS com substituição tributária
decimal0 - 1156Alíquota da reduçao da base de cálculo por substituição tributária
decimal0 - 1152Valor da reduçao da base de cálculo por substituição tributária
decimal0 - 1152Valor da base de cálculo por substituição tributária
decimal0 - 1156Alíquota do ISS por substituição tributária
decimal0 - 1152Valor do ISS por substituição tributária
string0 - 120000Descrição do serviço
integer0 - 170Obsoleto. Campo mantido apenas para não quebrar antigas integrações. Informar na tag Endereco
int0 - 170Município de incidência
0 - 100Endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
string0 - 1200Obsoleto. Campo mantido apenas para não quebrar antigas integrações. Informar na tag Endereco
string0 - 1500Obsoleto. Campo mantido apenas para não quebrar antigas integrações. Informar na tag Endereco
string0 - 1100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string0 - 1300Número do processo
boolean0 - 100Tributa no município do prestador
string0 - 100Responsável pela retenção
0 - 100
string0 - 12550Descrição do código CNAE
string0 - 110000Descrição do código de serviço
string0 - 12550Descrição da unidade de medida
string0 - 12550Descrição da CFOP
string0 - 110000
0 - N00Informações Adicionais
string0 - 11500Nome
string1 - 12550Tag
string1 - 110000Valor
0 - N00Deduções
string0 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
long0 - 1140CPF/CNPJ referência
string0 - 11000Qual tipo de Dedução
string0 - 12550Descrição da dedução
long0 - 1150Número da nota de referência
decimal0 - 1154Percentual a deduzir
decimal0 - 1152Valor a deduzir
decimal0 - 1152Valor total
string0 - 100Flag para indicar se o serviço foi prestado em vias públicas
0 - 100Materiais para dedução
1 - N00Material para dedução
long0 - 1150Número da nota NF-e
string0 - 12550Descrição do material
decimal0 - 1154Quantidade
decimal0 - 1154Valor unitário
decimal0 - 1152Valor total
string0 - 1150Indicador de CPF/CNPJ do Emissor
long0 - 1140CPF/CNPJ do Emissor
0 - 100Valores refente a nota
decimal1 - 1156Alíquota ISS
decimal0 - 1156Alíquota do Simples Nacional
decimal0 - 1152Total valor de deduções
decimal0 - 1152Total valor ISS
decimal0 - 1152Total valor crédito
decimal0 - 1152Total valor de desconto incondicional
decimal0 - 1152Total valor de desconto condicional
decimal0 - 1152Total valor base de calculo ISS
decimal1 - 1152Total valor de serviço
string0 - 12550Total do valor da nota por extenso
decimal1 - 1152Total valor líquido/nominal
string0 - 12550Total do valor líquido/nominal da nota por extenso
0 - 100Retenções referente a nota
boolean0 - 100ISS é Retido?
decimal0 - 1156Alíquota PIS
decimal0 - 1156Alíquota COFINS
decimal0 - 1156Alíquota INSS
decimal0 - 1156Alíquota IR
decimal0 - 1156Alíquota CSLL
decimal0 - 1152Total valor PIS
decimal0 - 1152Total valor COFINS
decimal0 - 1152Total valor INSS
decimal0 - 1152Total valor IR
decimal0 - 1152Total valor CSLL
decimal0 - 1152Total valor ISS Retido
decimal0 - 1152Total valor outras retenções
0 - 100Informações de ISS com substituição tributária
decimal0 - 1156Alíquota da reduçao da base de cálculo por substituição tributária
decimal0 - 1152Valor da reduçao da base de cálculo por substituição tributária
decimal0 - 1152Valor da base de cálculo por substituição tributária
decimal0 - 1156Alíquota do ISS por substituição tributária
decimal0 - 1152Valor do ISS por substituição tributária
0 - 100Informações complementares para impressão
string0 - 110000Conteúdo imprimir no cabeçalho
string0 - 120000Conteúdo imprimir rodapé/Outras informações
string0 - 1500Nome do arquivo da logo do prestador para ser impresso. A logo deve estar na pasta templates
string0 - 1500Nome do template que deseja utilizar para impressão. O template deve estar na pasta Templates
string0 - 12550Descrição da natureza de operação
string0 - 12550Descrição do regime de tributação
string0 - 1500Município tributado
0 - 100Locais para impressão da nota
0 - N00Local para impressão da nota
string0 - 11000Nome da Impressora para imprimir a nota
int0 - 120Quantidade de cópias adicionais para imprimir
0 - 100Distribuição da nota após autorizada
1 - 100Lista de E-mails para enviar a nota além do Tomador.
string1 - N800
string0 - 120Regime especial de tributação
string0 - 1500Recolhimento
string0 - 11000Nome da Impressora para imprimir a nota
int0 - 120Quantide de impressão adicional
boolean0 - 100Tag para indicar que a nota é a última do lote quando for integração manual com a prefeitura. Em casos que a prefeitura não disponibiliza web service.
0 - 100Lista de arquivos vinculados. O ERP deve disponibilizar o arquivo em um diretório acessivel pelo NFSePack
1 - N00Arquivo Vinculado a nota para enviar em anexo por e-mail.
string1 - 13000Caminho completo do arquivo. Ex.: c:\arquivosVinculados\Boleto_37_2013_06_28.pdf
string0 - 1600Nome amigavel para o arquivo com extensão. Ex.: Boleto_37.pdf
string0 - 120Tipo do Arquivo: NaoDefinido = 1; Pdf = 2; Rtf = 3; Soap = 4; Zip = 5; Xml = 6; Html = 7; Plain = 8; RichText = 9; Gif = 10; Jpeg = 11; Tiff = 12;
string0 - 190Código Nomenclatura Brasileira de Serviços
string0 - 140Identificação da não exigibilidade do ISSQN
0 - N00Deduções a nível de RPS
string0 - 120Tipo da dedução. Ex.: 1, 2, 99
string0 - 11500Descrição da dedução
nonNegativeInteger0 - 170Código IBGE do município gerador da NFSe vinculada à dedução
nonNegativeInteger0 - 1150Número da NFSe vinculada à dedução
string0 - 190Código verificador da NFSe vinculada à dedução
nonNegativeInteger0 - 190Número da NFe vinculada à dedução
string0 - 120Sigla da UF emissora da NFe vinculada à dedução
string0 - 1440Chave de acesso da NFe vinculada à dedução
string0 - 12550Identificador de outro documento que não seja NFSe ou NFe
string0 - 1150Indicador de CPF/CNPJ do Fornecedor da dedução
nonNegativeInteger0 - 1140CPF/CNPJ do fornecedor nacional
string0 - 1400NIF do fornecedor do exterior
string0 - 140Código do país do fornecedor do exterior
date0 - 100Data de emissão da dedução
decimal0 - 1152Valor dedutível
decimal0 - 1152Valor utilizado na dedução

Layout de Retorno

Estrutura do XML de retorno do NFSePack:

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaRps1 - 100Representa a estrutura de resposta da integração de RPS
string1 - 100Versão do NFSePack
0 - 100Detalhes do Erro
string1 - 100Descrição do Erro
string0 - 100Erro não tratado
1 - 100Status integração
boolean1 - 100RPS Integrado
string0 - 100Prestador Ativado/Desativado
Inicio

Recepcionar Cancelamento de NFSe

Este serviço é reponsável por receber uma string com o layout de solicitação de cancelamento de uma NFSe, ou seja, o RPS deve estar autorizado para ser solicitado o cancelamento.

Layout XML:

TagTipoOcorrênciaTamanhoDecimaisDescrição
CancelamentoWebServiceIntegracao1 - 100Estrutura para solicitação de cancelamento
string0 - 12550
long1 - 1140CPF/CNPJ do prestador do serviço
long1 - 1150Número da Nota Fiscal de Serviço eletrônica - NFSe
string1 - 150Série da NFSe
string1 - 140Código de cancelamento conforme exigência da prefeitura.
string0 - 15000Descrição/Motivo do cancelamento.

Layout de Retorno

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaCancelamento1 - 100Estrutura de resposta da solicitação de cancelamento da NFSe
string1 - 100Versão do NFSePack
0 - 100Detalhes do Erro
string1 - 100Descrição do Erro
string0 - 100Erro não tratado
1 - 100Status integração
boolean1 - 100Solicitação de cancelamento integrada
string0 - 100Prestador Ativado/Desativado
Inicio

Recepcionar Consulta de RPS

Este serviço é reponsável por receber uma string com o layout de solicitação de consulta do RPS, onde retornará todos os dados do RPS, status atual e os eventos ocorrido.

Layout XML:

TagTipoOcorrênciaTamanhoDecimaisDescrição
ConsultaRpsWebServiceIntegracao1 - 100Estrutura para solicitação de consulta do RPS
long1 - 1140CPF/CNPJ do prestador do serviço
long1 - 1150Número do RPS
string1 - 150Série do RPS

Layout de Retorno

Abaixo é apresentado o layout de retorno caso houver algum erro na consulta, caso contrário retornará toda a estrutura do RPS integrado com tag's adicionais informando o status atual e todos os eventos ocorridos.

TagTipoOcorrênciaTamanhoDecimaisDescrição
TNFSe1 - 100Estrutura de retorno na consulta da NFS-e
longNão Definido00Identificador arquivo XML autorizado na prefeitura
string0 - 100Código verificador
dateTimeNão Definido00Data de Emissão da NFS-e
integer0 - 160Ano Mês Competência
long0 - 1150Número da NFSe
stringNão Definido300Código da Natureza de Operação
stringNão Definido100Código do Serviço Prestado
integerNão Definido10Optante pelo Simples Nacional
booleanNão Definido00Incentivo a Cultura
stringNão Definido50Incentivo fiscal
long1 - 1150Número do RPS
string1 - 150Série do RPS
string1 - 1100Tipo de RPS
dateTime1 - 100Data de Emissão do RPS
stringNão Definido150Status/Situação do RPS
stringNão Definido200Código fiscal da prestação do serviço
dateTime0 - 100Data e hora do cancelamento.
long0 - 1150Número Guia
dateTime0 - 100Data e hora da quitação da guia
1 - 100Prestador dos Serviços
string1 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string1 - 11150Razão social
string0 - 1600Nome fantasia
long1 - 1140CPF/CNPJ
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 1800Site
date0 - 100Data de Adesão do Simples Nacional
0 - 100Endereço
integer0 - 170Código IBGE
string0 - 1600Bairro
long0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - 100Tomador dos Serviços
long0 - 1140CPF/CNPJ
string0 - 1300
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string0 - 1100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string0 - 11150Razão social
string0 - 1600Nome fantasia
string0 - 1300Situação
string0 - 1800E-mail
string0 - 1200Telefone
0 - 100Endereço
integer0 - 170Código IBGE
string0 - 1600Bairro
long0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - N00Lista de discriminação dos Serviços
decimal1 - 1152Valor do Serviço
decimal0 - 1152Valor unitário
decimal0 - 1154Quantidade
string0 - 1200Unidade de medida
decimal0 - 1152Valor Deduções
string0 - 12550Descrição/motivo da dedução
decimal0 - 1152Valor PIS
decimal0 - 1156Alíquota PIS
decimal0 - 1152Valor COFINS
decimal0 - 1156Alíquota COFINS
decimal0 - 1152Valor INSS
decimal0 - 1156Alíquota INSS
decimal0 - 1152Valor IR
decimal0 - 1156Alíquota IR
decimal0 - 1152Valor CSLL
decimal0 - 1156Alíquota CSLL
string0 - 1100Código do serviço
string0 - 1200CFOP
string0 - 12550Código CNAE
string0 - 1200ID do código CNAE
string0 - 1300Código de tributação municipal
decimal0 - 1152Valor da base de calcúlo ISS
decimal0 - 1156Alíquota ISS
decimal0 - 1152Valor ISS
decimal0 - 1152Valor Líquido
decimal0 - 1152Valor outras retenções
decimal0 - 1152Valor crédito
boolean0 - 100ISS é Retido?
decimal0 - 1152Valor do ISS Retido
decimal0 - 1152Valor do desconto incondicional
decimal0 - 1152Valor do desconto condicional
string0 - 120000Descrição do serviço
string0 - 120000Descrição do serviço para exibição no Danfse
integer0 - 170Obsoleto. Campo mantido apenas para não quebrar antigas integrações. Informar na tag Endereco
0 - 100Município de incidência
integer1 - 170Código IBGE
string1 - 1100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string1 - 1500Cidade
string1 - 120Estado/UF
1 - 100
1 - 100
1 - 100
0 - 100Endereço
integer0 - 170Código IBGE
string0 - 1600Bairro
long0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo Endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
string0 - 1200Obsoleto. Campo mantido apenas para não quebrar antigas integrações. Informar na tag Endereco
string0 - 1500Obsoleto. Campo mantido apenas para não quebrar antigas integrações. Informar na tag Endereco
string0 - 1100Obsoleto. Campo mantido apenas para não quebrar antigas integrações.
string0 - 1300Número do processo
boolean0 - 100Tributa no município do prestador
string0 - 100Responsável pela retenção
0 - 100
string0 - 12550Descrição do código CNAE
string0 - 110000Descrição do código de serviço
string0 - 12550Descrição da unidade de medida
string0 - 12550Descrição da CFOP
string0 - 110000
0 - N00Informações Adicionais
string0 - 11500Nome
string1 - 12550Tag
string1 - 110000Valor
0 - N00Deduções
string0 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
long0 - 1140CPF/CNPJ referência
string0 - 11000Qual tipo de Dedução
string0 - 12550Descrição da dedução
long0 - 1150Número da nota de referência
decimal0 - 1154Percentual a deduzir
decimal0 - 1152Valor a deduzir
decimal0 - 1152Valor total
string0 - 100Flag para indicar se o serviço foi prestado em vias públicas
0 - 100Materiais para dedução
1 - N00Material para dedução
long0 - 1150Número da nota NF-e
string0 - 12550Descrição do material
decimal0 - 1154Quantidade
decimal0 - 1152Valor unitário
decimal0 - 1152Valor total
string0 - 1150Indicador de CPF/CNPJ do Emissor
long0 - 1140CPF/CNPJ do Emissor
0 - 100Valores refente a nota
decimal1 - 1156Alíquota ISS
decimal0 - 1156Alíquota do Simples Nacional
decimal0 - 1152Total valor de deduções
decimal0 - 1152Total valor ISS
decimal0 - 1152Total valor crédito
decimal0 - 1152Total valor de desconto incondicional
decimal0 - 1152Total valor de desconto condicional
decimal0 - 1152Total valor base de calculo ISS
decimal1 - 1152Total valor de serviço
string0 - 12550Total do valor da nota por extenso
decimal1 - 1152Total valor líquido/nominal
string0 - 12550Total do valor líquido/nominal da nota por extenso
0 - 100Retenções referente a nota
boolean0 - 100ISS é Retido?
decimal0 - 1156Alíquota PIS
decimal0 - 1156Alíquota COFINS
decimal0 - 1156Alíquota INSS
decimal0 - 1156Alíquota IR
decimal0 - 1156Alíquota CSLL
decimal0 - 1152Total valor PIS
decimal0 - 1152Total valor COFINS
decimal0 - 1152Total valor INSS
decimal0 - 1152Total valor IR
decimal0 - 1152Total valor CSLL
decimal0 - 1152Total valor ISS Retido
decimal0 - 1152Total valor outras retenções
1 - 100Informações da NFS-e
integer1 - 100Código do status da Nota Fiscal de Serviço
string1 - 100Descrição status da Nota Fiscal de Serviço
1 - 100Lista de eventos da NFS-e
0 - N00
integer1 - 100Código do Evento
string1 - 100Descrição do Evento
string1 - 100Data e hora do primeiro evento registrado
string1 - 100Data e hora do segundo evento registrado
integer1 - 100Quantidade de eventos
0 - 100Lista de detalhes do evento
0 - N00
string1 - 11250Descrição
string1 - 100Data e hora do registro
boolean0 - 100Indicador em que o RPS pode ser duplicado na prefeitura caso o reenvio ser efetuado. Essa situação abrange RPS's com status 'Verificar na Prefeitura'
string1 - 100Versão do NFSePack
1 - 100Detalhes do Erro
string1 - 100
string0 - 100Erro não tratado
1 - 100Status da consulta
boolean1 - 100RPS consultado
Inicio

Recepcionar Inutilização de RPS

Este serviço é reponsável por receber uma string com o layout de solicitação de inutilização do RPS, lembrando que não tem vinculo nenhum com a prefeitura. É somente um status para o cliente marcar o RPS como descartado. Isso quando a prefeitura não exigir a sequêcia correta dos RPS, caso exigir deve-se autorizar todos os RPS, ou seja, caso houver alguma rejeição ou critica, deve-se corrigir e retransmitir para a prefeitura.

Layout XML:

TagTipoOcorrênciaTamanhoDecimaisDescrição
Inutilizar1 - 100Estrutura para inutilização de RPS
1 - N00Identificador do RPS
long1 - 1150Número do RPS
string1 - 150Série do RPS
long1 - 1140CPF/CNPJ do prestador do serviço

Layout de Retorno

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaInutilizar1 - 100Estrutura de resposta de integração de inutilização
string1 - 100Versão do NFSePack
1 - 100Campos ou grupos que farão parte de uma escolha
1 - 100Detalhes do Erro
string1 - 100Descrição do Erro
string0 - 100Erro não tratado
1 - 100Status Inutilização
boolean1 - 100Inutilização Integrada
1 - 100Lista de RPS a ser inutilizado
1 - 100Identificador do RPS
long1 - 1150Número do RPS
string1 - 150Série do RPS
long1 - 1140CPF/CNPJ do prestador do serviço
boolean1 - 100Inutilização Integrada
0 - 100Detalhes do Erro
string1 - 100Descrição do Erro
string0 - 100Erro não tratado
Inicio

Recepcionar Solicitação de Impressão

Este serviço é reponsável por receber uma string com o layout de solicitação de impressão.

Layout XML

TagTipoOcorrênciaTamanhoDecimaisDescrição
SolicitarImpressaoWebServiceIntegracao1 - 100Estrutura de solicitação de impressão
long1 - 1140CPF/CNPJ do prestador de serviço
long1 - 1150Número da NFSe
string1 - 150Série da Nota

Layout de Retorno

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaSolicitacaoImpressao1 - 100Estrutura de resposta da solicitação de impressão
string1 - 100Versão do NFSePack
0 - 100Detalhes do Erro
string1 - 100Descrição do Erro
string0 - 100Erro não tratado
1 - 100Status da solicitação de impressão
boolean1 - 100Inutilização Integrada
Inicio

Recepcionar Final Lote

Para as prefeituras que não disponibilizam web service para integração de NFS-e, é necessário gerar um arquivo contendo o(s) RPS(s). Há sistemas que aceitam realizar o upload de um lote de RPS, outros somente de um RPS. Para os sistemas que aceitam um lote de RPS, há como configurar no NFSePack um número mínimo de RPS por lote, ou seja, o NFSePack aguardará até completar este número de RPS para gerar um único arquivo.

Caso o usuário necessite gerar o lote sem completar o número mínimo de RPS, poderá ser utilizado este serviço para indicar que pode gerar o lote com os RPSs integrados no NFSePack.

Layout XML

TagTipoOcorrênciaTamanhoDecimaisDescrição
RpsFinalLote1 - 100
long1 - 1140CNPJ do prestador. Caso for informado somente o CNPJ, o NFSePack vai setar o último RPS integrado como sendo o último do lote.
0 - 100Informar até qual RPS deve ser incluído no lote.
long1 - 1150Número do RPS. Informado para indicar até qual RPS será incluído no lote.
string1 - 150Série do RPS.

Layout de Retorno

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaRpsFinalLote1 - 100Estrutura de resposta final lote
string1 - 100Versão do NFSePack
0 - 100Detalhes do Erro
string1 - 100Descrição do Erro
string0 - 100Erro não tratado
1 - 100Status da solicitação de final lote
boolean1 - 100Final lote integrado
Inicio

Recepcionar DIR

DIR DIR DIR DIR DIR DIR

Layout XML

TagTipoOcorrênciaTamanhoDecimaisDescrição
DIR1 - 100Representa a estrutura do XML de integração da DIR com o NFSePack
integer1 - 160Ano Mês Competência
string0 - 1300Código da Natureza de Operação
string0 - 1300Operação.
string0 - 1100Código do serviço Prestado
integer0 - 110Optante pelo Simples Nacional
boolean0 - 100Incentivo a Cultura
long1 - 1150Número da NFS-e
string1 - 150Série da NFS-e
string0 - 1100Tipo da NFSe
dateTime1 - 100Data de Emissão da NFS-e
string0 - 110000Outras Informações
string0 - 1300Situação
string0 - 1200Código fiscal da prestação do serviço
1 - 100Prestador dos Serviços
string0 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string1 - 11150Razão social
string0 - 1600Nome fantasia
string1 - 1140CPF/CNPJ
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 120DDD Telefone do Prestador
string0 - 1800Site
date0 - 100Data de Adesão do Simples Nacional
string0 - 100Indica se optante Simples Nacional
0 - 100endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - 100Tomador dos serviços
string1 - 1140CPF/CNPJ
string0 - 1300
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string0 - 11150Razão social
string0 - 1600Nome fantasia
string0 - 1300Situação
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 120DDD Telefone do Tomador
0 - 100endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - 100Lista de discriminação dos Serviços
decimal1 - 1154Valor do serviço
decimal0 - 1154Valor unitário
decimal0 - 1154Quantidade
string0 - 1200Unidade de medida
decimal0 - 1152Valor Deduções
string0 - 12550Descrição/motivo da dedução
decimal0 - 1152Valor PIS
decimal0 - 1156Alíquota PIS
decimal0 - 1152Valor COFINS
decimal0 - 1156Alíquota COFINS
decimal0 - 1152Valor INSS
decimal0 - 1156Alíquota INSS
decimal0 - 1152Valor IR
decimal0 - 1156Alíquota IR
decimal0 - 1152Valor CSLL
decimal0 - 1156Alíquota CSLL
string1 - 1100Código do serviço sem formatação Ex: "ISS-17.03" deve-se enviar "1703"
string0 - 1200CFOP
string0 - 100Código Substituição Tributária
string0 - 12550Código CNAE
string0 - 1200ID do Código CNAE
string0 - 1300Código de tributação municipal
decimal0 - 1154Valor da base de calculo ISS
decimal0 - 1156Alíquota ISS
decimal0 - 1152Valor ISS
decimal0 - 1152Valor Líquido
decimal0 - 1152Valor outras retenções
decimal0 - 1152Valor crédito
boolean0 - 100ISS é Retido?
decimal0 - 1152Valor do ISS Retido
decimal0 - 1152Valor do desconto incondicional
decimal0 - 1152Valor do desconto condicional
0 - 100Informações de ISS com substituição tributária
decimal0 - 1156Alíquota da redução da base de cálculo por substituição tributária
decimal0 - 1152Valor da redução da base de cálculo por substituição tributária
decimal0 - 1152Valor da base de cálculo por substituição tributária
decimal0 - 1156Alíquota do ISS por substituição tributária
decimal0 - 1152Valor do ISS por substituição tributária
string0 - 120000Descrição do serviço
int1 - 170Código IBGE do município de incidência
0 - 100endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
string0 - 1300Número do processo
boolean0 - 100Tributa no município do prestador
string0 - 100Responsável pela retenção
0 - N00Informações Adicionais
string0 - 11500Nome
string1 - 12550Tag
string1 - 110000Valor
0 - N00Deduções
string0 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1140CPF/CNPJ referência
string0 - 11000Qual tipo de dedução
string0 - 12550Descrição da dedução
long0 - 1150Número da nota de referência
decimal0 - 1154Percentual a deduzir
decimal0 - 1152Valor a deduzir
decimal0 - 1152Valor total
string0 - 100Flag para indicar se o serviço foi prestado em vias públicas
string0 - 120Regime especial de tributação
0 - 100Informações contábeis da DIR
0 - 100Identificação da conta contábil
0 - 100Descrição da conta contábil
0 - 100Identificação da conta contábil sintética
0 - 100Código do item lista serviços
0 - 100Identificação da conta COSIF
0 - 100Valor contábil

Layout de Retorno

TEMPORARIAMENTE INDEFINIDO Inicio

Recepcionar Lote DIR

Estrutura de integração para geração do conteúdo do arquivo para importação no sistema da prefeitura.

Layout XML

TagTipoOcorrênciaTamanhoDecimaisDescrição
LoteDIR1 - 100Estrutura contendo os documentos da DIR.
string1 - 1140CNPJ do tomador (empresa declarante).
int1 - 170Código IBGE do município de declaração.
1 - 100Lista dos documentos que serão inclusos na declaração.
1 - N00Representa a estrutura do XML de integração da DIR com o NFSePack
integer1 - 160Ano Mês Competência
string0 - 1300Código da Natureza de Operação
string0 - 1300Operação.
string0 - 1100Código do serviço Prestado
integer0 - 110Optante pelo Simples Nacional
boolean0 - 100Incentivo a Cultura
long1 - 1150Número da NFS-e
string1 - 150Série da NFS-e
string0 - 1100Tipo da NFSe
dateTime1 - 100Data de Emissão da NFS-e
string0 - 110000Outras Informações
string0 - 1300Situação
string0 - 1200Código fiscal da prestação do serviço
1 - 100Prestador dos Serviços
string0 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string1 - 11150Razão social
string0 - 1600Nome fantasia
string1 - 1140CPF/CNPJ
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 120DDD Telefone do Prestador
string0 - 1800Site
date0 - 100Data de Adesão do Simples Nacional
string0 - 100Indica se optante Simples Nacional
0 - 100endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - 100Tomador dos serviços
string1 - 1140CPF/CNPJ
string0 - 1300
string1 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1200Alvará
string0 - 1150Inscrição municipal
string0 - 1200Inscrição estadual
string0 - 11150Razão social
string0 - 1600Nome fantasia
string0 - 1300Situação
string0 - 1800E-mail
string0 - 1200Telefone
string0 - 120DDD Telefone do Tomador
0 - 100endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
1 - 100Lista de discriminação dos Serviços
decimal1 - 1154Valor do serviço
decimal0 - 1154Valor unitário
decimal0 - 1154Quantidade
string0 - 1200Unidade de medida
decimal0 - 1152Valor Deduções
string0 - 12550Descrição/motivo da dedução
decimal0 - 1152Valor PIS
decimal0 - 1156Alíquota PIS
decimal0 - 1152Valor COFINS
decimal0 - 1156Alíquota COFINS
decimal0 - 1152Valor INSS
decimal0 - 1156Alíquota INSS
decimal0 - 1152Valor IR
decimal0 - 1156Alíquota IR
decimal0 - 1152Valor CSLL
decimal0 - 1156Alíquota CSLL
string1 - 1100Código do serviço sem formatação Ex: "ISS-17.03" deve-se enviar "1703"
string0 - 1200CFOP
string0 - 100Código Substituição Tributária
string0 - 12550Código CNAE
string0 - 1200ID do Código CNAE
string0 - 1300Código de tributação municipal
decimal0 - 1154Valor da base de calculo ISS
decimal0 - 1156Alíquota ISS
decimal0 - 1152Valor ISS
decimal0 - 1152Valor Líquido
decimal0 - 1152Valor outras retenções
decimal0 - 1152Valor crédito
boolean0 - 100ISS é Retido?
decimal0 - 1152Valor do ISS Retido
decimal0 - 1152Valor do desconto incondicional
decimal0 - 1152Valor do desconto condicional
0 - 100Informações de ISS com substituição tributária
decimal0 - 1156Alíquota da redução da base de cálculo por substituição tributária
decimal0 - 1152Valor da redução da base de cálculo por substituição tributária
decimal0 - 1152Valor da base de cálculo por substituição tributária
decimal0 - 1156Alíquota do ISS por substituição tributária
decimal0 - 1152Valor do ISS por substituição tributária
string0 - 120000Descrição do serviço
int1 - 170Código IBGE do município de incidência
0 - 100endereço
integer1 - 170Código IBGE
string0 - 1600Bairro
string0 - 1100CEP
string0 - 1500Cidade
string0 - 1600Complemento
string0 - 11250Descrição
string0 - 1100Número
string0 - 120Estado/UF
string0 - 12550Tipo endereço. Ex.: Rua. AV.
string0 - 12550Tipo Bairro
string0 - 1200Código do Pais. Tabela BACEN
string0 - 1500Nome do país
string0 - 150Sigla do país
string0 - 1300Número do processo
boolean0 - 100Tributa no município do prestador
string0 - 100Responsável pela retenção
0 - N00Informações Adicionais
string0 - 11500Nome
string1 - 12550Tag
string1 - 110000Valor
0 - N00Deduções
string0 - 1150Valores aceitos: Cnpj, Cpf e CpfNaoInformado
string0 - 1140CPF/CNPJ referência
string0 - 11000Qual tipo de dedução
string0 - 12550Descrição da dedução
long0 - 1150Número da nota de referência
decimal0 - 1154Percentual a deduzir
decimal0 - 1152Valor a deduzir
decimal0 - 1152Valor total
string0 - 100Flag para indicar se o serviço foi prestado em vias públicas
string0 - 120Regime especial de tributação
0 - 100Informações contábeis da DIR
0 - 100Identificação da conta contábil
0 - 100Descrição da conta contábil
0 - 100Identificação da conta contábil sintética
0 - 100Código do item lista serviços
0 - 100Identificação da conta COSIF
0 - 100Valor contábil

Layout de Retorno

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaLoteDIR1 - 100Lote de documentos (NFS-e) a serem declarados com serviços tomados.
long1 - 1140CNPJ do declarante (Tomador do serviço)
int1 - 170Código IBGE do município de declaração.
0 - 100Lista de arquivos gerados com base no lote de DIR.
1 - N00Arquivo para ser realizado a importação no sistema da prefeitura.
string1 - 199999990Conteúdo do arquivo conforme layout do sistema da prefeitura para ser realizado o download.
1 - 100Lista de documentos que estão contidos no arquivo que esta sendo declarado.
1 - N00Indice das linhas contidas no arquivo que representão informações do documento.
1 - 100Informações que identificam a NFS-e que está sendo declara na DIR.
int1 - 1150Número do documento.
string1 - 150Série do documento.
long1 - 1140CNPJ do emissor do documento.
int1 - 1150Primeira linha do arquivo referente ao documento.
int1 - 1150Última linha do arquivo referente ao documento.
0 - 100Lista com erros dos documentos que não foram inclusos no arquivo.
1 - N00Detalhes do erro.
1 - 100Informações que identificam a NFS-e que está sendo declara na DIR.
int1 - 1150Número do documento.
string1 - 150Série do documento.
long1 - 1140CNPJ do emissor do documento.
int1 - 1150Código do erro.
string1 - 15000Descricão do código.
1 - 100Detalhes do erro.
int1 - 1150Código do erro.
string1 - 15000Descricão do código.
Inicio

Recepcionar Consulta da Integração com o Sistema da Prefeitura

Estrutura para realizar a consulta da forma que é realizado a integração da DIR no sistema da prefeitura. Com base nesta consulta o sistema que esta integrando poderá decidir qual operação de integração chamar para geração da DIR e quais prefeituras são atendidas pelo NFSePack.

Layout XML

TagTipoOcorrênciaTamanhoDecimaisDescrição
IntegracaoPrefeituraDIR1 - 100Consulta da forma de integração da DIR com o sistema da prefeitura.
1 - 100Lista de prefeituras para consultar forma de integração com seus sistema de DIR.
1 - N00Identificação da prefeitura.
int1 - 170Código IBGE do município de declaração.

Layout de Retorno

TagTipoOcorrênciaTamanhoDecimaisDescrição
RespostaIntegracaoPrefeituraDIR1 - 100Resposta da consulta do tipo de integração da DIR com o sistema da prefeitura.
1 - 100Lista das prefeituras consultadas.
1 - N00Informações da prefeitura.
int1 - 170Código IBGE do município de declaração.
int1 - 120Forma de integração com o sistema da prefeitura.
1 - 100Detalhes do erro.
1 - 100Código do erro.
1 - 100Descrição do código.
Inicio